/*-
 * CheckPIN.java
 *
 * $LastChangedBy:  $
 * $LastChangedRevision:  $
 * $LastChangedDate:  $
 * $HeadURL: $
 *
 * Copyright (c) 2008, Stein Gunnar Bakkeby
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Stein Gunnar Bakkeby nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.googlecode.attention.at;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class CheckPIN extends AtCommand<CheckPIN> {

  private CPINStatus status;
  
  public CheckPIN(AtListener<CheckPIN> listener) {
    super(listener);
  }
  
  /** Test command, expects "OK" response. */
  public void prepareTest() {
    setCommand("AT+CPIN=?", Command.TEST);
  }
  
  public void prepareRead() {
    setCommand("AT+CPIN?", Command.READ);
  }
  
  /**
   * This will try to unlock the phone using the given pin code. Note that
   * entering the wrong pin can and will result in the SIM card being blocked.
   * Setting of new PIN is not supported by this method.
   * 
   * @param pin The four digit PIN code
   * @see #prepareExecute(String)
   */
  public void prepareExecute(final int pin) {
    prepareExecute(String.valueOf(pin));
  }
  
  /**
   * This will try to unlock the phone using the given pin code. Note that
   * entering the wrong pin can and will result in the SIM card being blocked.
   * Setting of new PIN is not supported by this method.
   * 
   * @param pin The four digit PIN code
   * @see #prepareExecute(int)
   */
  public void prepareExecute(final String pin) {
    setCommand("AT+CPIN=" + pin, Command.EXECUTE);
  }
  
  @Override
  protected CheckPIN getThis() {
    return this;
  }
  
  public CPINStatus getStatus() {
    return status;
  }
  
  /*
   * Nothing to do, success parsing handled by AtCommand. 
   */
  @Override
  protected void parseTest(final String response) {}
  
  @Override
  protected void parseRead(final String response) {
    final Pattern pattern = Pattern.compile(
        "\\+CPIN: ([-A-Za-z]+(?:[ ][PINUK]{3})?[2]?)");
    final Matcher matcher = pattern.matcher(response);
    if (matcher.find()) {
      final String code = matcher.group(1);
      status = CPINStatus.parse(code);
    }
  }
  
  @Override
  protected void parseExecute(final String response) {}
}
